docs: chiarisce ruolo e flusso canonico del toolkit#66
Merged
Conversation
- hook in plain language prima del gergo tecnico - installazione e quickstart portati in cima - rimosso TOOLKIT_OUTDIR dal quickstart (non necessario per project-example) - py -m toolkit.cli.app spostato come fallback, non come comando principale - dry-run duplicato rimosso
…_url - conventions.md: sezione 'Fonti pubbliche italiane' con encoding, ZIP/XLSX, schema instabile, colonne posizionali, chiavi territoriali - README quickstart: menzione inspect paths e link a notebook-contract - feature-stability.md: scout_url aggiunto come experimental
- publish_check.md: py -m toolkit.cli.app -> toolkit, rimosso contesto audit - feature-stability.md: riga vuota mancante prima di 'Lettura equivalente' - runtime-boundaries.md: aggiunge toolkit.cross (advanced) e scout_url (experimental) - conftest.py: rimosso riferimento a test_deprecated_shims.py (file mai creato)
Gabrymi93
approved these changes
Mar 23, 2026
Member
Gabrymi93
left a comment
Gabrymi93
left a comment
There was a problem hiding this comment.
CI verde su tutti i check (Ubuntu + Windows, Python 3.10 e 3.11). Docs-only, zero tocchi al runtime. Scope rispettato: README piu' diretto, conventions.md centralizzato, publish_check.md allineato ai comandi CLI canonici, runtime-boundaries.md con distinzione core/advanced/experimental/compat, conftest.py pulito da riferimento a file mai esistito. Coerente con il refactor cross-repo.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Refs dataciviclab/lab-ops#60
Sintesi
Riallinea la documentazione del
toolkital flusso canonico del Lab, chiarendo meglio:Cosa cambia
README
inspect paths,schema-diff,cross_yeare i rerun parziali nel giusto perimetroDocumentazione tecnica
docs/conventions.mdcome pagina di contratto operativo più chiara e centralizzatadocs/publish_check.mdsui comandi CLI canonici post-install (toolkit ...)docs/runtime-boundaries.mdper distinguere meglio:scout-url)scout_urlalla matrice indocs/feature-stability.mdTest collection
tests/conftest.pyil riferimento atest_deprecated_shims.py, file che non esiste nel repoPerché
Nel refactor UX cross-repo il
toolkitdeve presentarsi in modo coerente con il resto dell'ecosistema:Questa PR fa soprattutto pulizia di framing e riduce alcune ambiguità residue nella docs del toolkit.
Verifica
Verificato localmente che:
199 passedcompatintests/conftest.pyREADME.mdedocs/publish_check.mdsono coerenti con il CLI canonicotoolkitComando usato:
./.venv/Scripts/python.exe -m pytest -qTipo
DOCS